'\" te
.\" Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH LIBUMEM 3LIB "February 23, 2020"
.SH NAME
libumem \- object-caching memory allocation library
.SH SYNOPSIS
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lumem\fR [ \fIlibrary\fR... ]
#include <\fBumem.h\fR>
.fi

.SH DESCRIPTION
Functions in this library provide fast, scalable object-caching memory
allocation with multithreaded application support. In addition to the standard
\fBmalloc\fR(3C) family of functions and the more flexible
\fBumem_alloc\fR(3MALLOC) family, \fBlibumem\fR provides powerful
object-caching services as described in \fBumem_cache_create\fR(3MALLOC).
.sp
.LP
The \fBlibumem\fR library also provides extensive debugging support, including
detection of memory leaks, buffer overruns, multiple frees, use of
uninitialized data, use of freed data, and many other common programming
errors. See \fBumem_debug\fR(3MALLOC).
.SH INTERFACES
The shared object \fBlibumem.so.1\fR provides the public interfaces defined
below. See \fBIntro\fR(3) for additional information on shared object
interfaces.
.sp

.sp
.TS
l l
l l .
\fBcalloc\fR	\fBfree\fR
\fBmalloc\fR	\fBmemalign\fR
\fBrealloc\fR	\fBumem_alloc\fR
\fBumem_cache_alloc\fR	\fBumem_cache_create\fR
\fBumem_cache_destroy\fR	\fBumem_cache_free\fR
\fBumem_free\fR	\fBumem_nofail_callback\fR
\fBumem_setmtbf\fR	\fBumem_zalloc\fR
\fBvalloc\fR
.TE

.SH FILES
.ne 2
.na
\fB\fB/usr/lib/libumem.so.1\fR\fR
.ad
.RS 28n
shared object
.RE

.sp
.ne 2
.na
\fB\fB/usr/lib/64/libumem.so.1\fR\fR
.ad
.RS 28n
64-bit shared object
.RE

.SH ATTRIBUTES
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Evolving
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.BR Intro (3),
.BR malloc (3C),
.BR umem_alloc (3MALLOC),
.BR umem_cache_create (3MALLOC),
.BR umem_debug (3MALLOC),
.BR umem_setmtbf (3MALLOC),
.BR attributes (7)
